Skip to main content

DescribeZones

Description

call the DescribeZones to query the available area information of the specified region.

Request Method

POST

Request Path

/apsara/route/Slb/DescribeZones

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
regionIdBODYstringYesNo sample value for this parameter.region id
RegionIdBODYstringYescn-qingdao-env17-d01the region ID of the load balancing instance.
versionBODYstringNo2016-01-01version of api

Return data

NameTypeSample valueDescription
RequestIDstring1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DCRequest id

Example

Successful Response example

{
"RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}

title: ModifyVServerGroupBackendServers

ModifyVServerGroupBackendServers

Description

call ModifyVServerGroupBackendServers to replace back-end servers in the server group.

Request Method

POST

Request Path

/apsara/route/Slb/ModifyVServerGroupBackendServers

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
NewBackendServersBODYstringNo[{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.XX.XX. 6", "Port":"80","Description":"test-112" },{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "172.XX.XX. 6", "Port":"80","Description":"test-113" }]new list of back-end servers. a single call can call up to 20 back-end servers per server group. Value: is a Json string, and its structure is a JsonList. In a request, the list supports up to 20 elements. ServerId:String type, required, instance ID of the backend server. Port:Integer type, required, port used by backend server, value range:1~65535. Weight:Integer type, required, weight of backend server, value range:0~100. Description :String type, optional, backend server description, allow letters, numbers, dashes (-), forward slashes (/), half-width periods (.), and underscores (_). Chinese is supported. Type:String type, indicating the instance type of the backend server, value: ecs(default): ECS instance. eni: ENI instance. ServerIp: the instance IP of ECS or ENI. The example is as follows: example of mounting ECS:[{ "ServerId": "i-xxxxxxxxx", "Weight": "100", "Type": "ecs", "Port": "80", "Description": "test-112" }] mount ENI:[{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168.**.**", "Port": "80", "Description": "test-112" }] mount ENI multi-IP:[{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168.**.**", "Port": "80", "Description": "test-112" },{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "172.166.**.**", "Port": "80", "Description": "test-113" }]
VServerGroupIdBODYstringYesrsp-cige6j****server group ID.
regionIdBODYstringYesNo sample value for this parameter.region id
OldBackendServersBODYstringNo[{ "ServerId": "i-xxxxxxxxx", "Weight": "100", "Type": "ecs", "Port":"80","Description":"test-112" }]list of back-end servers to be replaced. Value: is a Json string, and its structure is a JsonList. In a request, the list supports up to 20 elements. ServerId:String type, required, instance ID of the backend server. Port:Integer type, required, port used by backend server, value range:1~65535. Weight:Integer type, required, weight of backend server, value range:0~100. Description :String type, optional, backend server description, 1-80 characters in length, supports letters, numbers, dashes (-), forward slashes (/), half-width periods (.) and underscores (_), and supports Chinese. Type:String type, indicating the instance type of the backend server, value: ecs(default):ECS instance. eni: ENI instance. ServerIp: the instance IP of ECS or ENI. The example is as follows: example of mounting ECS:[{ "ServerId": "i-xxxxxxxxx", "Weight": "100", "Type": "ecs", "Port": "80", "Description": "test-112" }] mount ENI:[{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168.**.**", "Port": "80", "Description": "test-112" }] mount ENI multi-IP:[{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168.**.**", "Port": "80", "Description": "test-112" },{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "172.166.**.**", "Port": "80", "Description": "test-113" }]
RegionIdBODYstringYescn-qingdao-env17-d01the region ID of the load balancing instance.
versionBODYstringNo2016-01-01version of api

Return data

NameTypeSample valueDescription
VServerGroupIdstringrsp-cige6j****server group ID.
ServerIdstringvm-236ECS instance ID or ENI instance ID.
RequestIdstring9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18Crequest ID.
BackendServerNo sample value for this parameter.No description for this parameter.
Portinteger70the port used by the backend server.
BackendServersarray of backendserverNo sample value for this parameter.backend server list.
Weightinteger100the weight of the back-end server.

Example

Successful Response example

{
"VServerGroupId":"rsp-cige6j****",
"ServerId":"vm-236",
"RequestId":"9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
"BackendServer":"",
"Port":"70",
"BackendServers":"",
"Weight":"100"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}